<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>websocket::stream::write_buffer_bytes (1 of 2 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../write_buffer_bytes.html" title="websocket::stream::write_buffer_bytes">
<link rel="prev" href="../write_buffer_bytes.html" title="websocket::stream::write_buffer_bytes">
<link rel="next" href="overload2.html" title="websocket::stream::write_buffer_bytes (2 of 2 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../write_buffer_bytes.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_buffer_bytes.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::write_buffer_bytes (1 of 2 overloads)">websocket::stream::write_buffer_bytes
          (1 of 2 overloads)</a>
</h6></div></div></div>
<p>
            Set the write buffer size option.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">void</span>
<span class="identifier">write_buffer_bytes</span><span class="special">(</span>
    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">amount</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.description">Description</a>
          </h7><p>
            Sets the size of the write buffer used by the implementation to send
            frames. The write buffer is needed when masking payload data in the client
            role, compressing frames, or auto-fragmenting message data. Lowering
            the size of the buffer can decrease the memory requirements for each
            connection, while increasing the size of the buffer can reduce the number
            of calls made to the next layer to write data. The default setting is
            4096. The minimum value is 8. The write buffer size can only be changed
            when the stream is not open. Undefined behavior results if the option
            is modified after a successful WebSocket handshake.
          </p>
<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.example"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.example">Example</a>
          </h7><p>
            Setting the write buffer size.
          </p>
<pre class="programlisting"><span class="identifier">ws</span><span class="special">.</span><span class="identifier">write_buffer_bytes</span><span class="special">(</span><span class="number">8192</span><span class="special">);</span>
</pre>
<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h3"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody><tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">amount</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The size of the write buffer in bytes.
                    </p>
                  </td>
</tr></tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="../write_buffer_bytes.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_buffer_bytes.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
